package mn.idax.exchange.otc.annotation;

import mn.idax.exchange.otc.enums.RequestLimitType;

import java.lang.annotation.*;

/**
 * @Auther: dison
 * @Date: 2018/8/14 13:57
 * @Description: 限流注解
 */
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface RequestLimit {

    /**
     * 资源的名字【可不填写】
     *
     * @return String
     */
    String name() default "";

    /**
     * 资源的key[存储的后缀]
     *
     * @return String
     */
    String key() default "";

    /**
     * Key的prefix[无需重新定义，已在拦截器中写入固定值]
     *
     * @return String
     */
    String prefix() default "";

    /**
     * 给定的时间段
     * 单位秒
     *
     * @return int
     */
    int period();

    /**
     * 最多的访问限制次数
     *
     * @return int
     */
    int count();

    /**
     * 类型
     *      三种类型：
     *          1.IP
     *          2.自定义
     *          3.类路径
     * @return RequestLimitType
     */
    RequestLimitType limitType() default RequestLimitType.CUSTOMER;
}
